Fzzy Config/me.fzzyhmstrs.fzzy_config.screen/PopupWidgetScreen

PopupWidgetScreen

open class PopupWidgetScreen(title: Text) : Screen, PopupParentElement

A base screen that supports popup widgets. See PopupParentElement for documentation on underlying implementations.

To add and remove popups from this screen, call PopupWidget.push and PopupWidget.pop

For most intents and purposes, treat this screen like a standard Screen, with a couple caveats:

Make sure to call super on resize, render, and keyPressed otherwise popup functionality will break
call super.render AFTER any custom rendering, or popups may appear improperly below custom elements
call super.keyPressed BEFORE custom key presses, otherwise clicks may improperly propagate through popups to elements underneath them

Author

fzzyhmstrs

Since

0.2.0, made render final and added renderContents 0.6.0

Parameters

title

Text, the screen title

Constructors

PopupWidgetScreen

constructor(title: Text)

Properties

dragging

var dragging: Boolean

focused

@Nullable

@get:Nullable

var focused: Element?

height

var height: Int

justClosedWidget

open override var justClosedWidget: Boolean

Boolean prevents mouseReleased from triggering on the Popup or Widget underneath the active popup if it's closed on mouseClicked

lastSelected

open override var lastSelected: Element?

getter and setter for the cached element.

popupWidgets

open override val popupWidgets: LinkedList<PopupWidget>

A stack for holding popupwidgets while allowing for easy list iteration as needed. For rendering this stack should be traversed in reverse order, which LinkedList makes easy with descendingIterator

width

var width: Int

Functions

activeWidget

open fun activeWidget(): PopupWidget?

applyKeyPressNarratorDelay

open fun applyKeyPressNarratorDelay()

applyMouseMoveNarratorDelay

open fun applyMouseMoveNarratorDelay()

applyMousePressScrollNarratorDelay

open fun applyMousePressScrollNarratorDelay()

applyNarratorModeChangeDelay

open fun applyNarratorModeChangeDelay()

charTyped

open override fun charTyped(chr: Char, modifiers: Int): Boolean

children

open override fun children(): MutableList<out Element>

open fun close()

filesDragged

open fun filesDragged(paths: MutableList<Path>)

focusOn

open fun focusOn(@Nullable element: Element?)

getFocusedPath

@Nullable

open override fun getFocusedPath(): GuiNavigationPath?

getMusic

@Nullable

open fun getMusic(): MusicSound?

getNarratedTitle

open fun getNarratedTitle(): Text

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationOrder

open fun getNavigationOrder(): Int

getNavigationPath

@Nullable

open override fun getNavigationPath(navigation: GuiNavigation): GuiNavigationPath?

getTitle

open fun getTitle(): Text

handleTextClick

open fun handleTextClick(@Nullable style: Style?): Boolean

hoveredElement

open fun hoveredElement(mouseX: Double, mouseY: Double): Optional<Element>

init

fun init(client: MinecraftClient, width: Int, height: Int)

isFocused

open override fun isFocused(): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

keyPressed

open override fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

keyReleased

open override fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

mouseClicked

override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseDragged

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

mouseReleased

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseScrolled

open override fun mouseScrolled(mouseX: Double, mouseY: Double, amount: Double): Boolean

narrateScreenIfNarrationEnabled

open fun narrateScreenIfNarrationEnabled(onlyChangedNarrations: Boolean)

onClick

open fun onClick(mouseX: Double, mouseY: Double, button: Int): Boolean

onDisplayed

open fun onDisplayed()

popLast

open override fun popLast()

Indicates that the overlay has been removed and the parent should return focus to the cached element, if any, in lastSelected

pushLast

open override fun pushLast()

Indicates to the parent element to cache it's current focused element. The current focused element should be stored in lastSelected

removed

open fun removed()

render

override fun render(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

Marked final to preserve proper popup ordering and rendering

renderBackground

open fun renderBackground(context: DrawContext)

renderBackgroundTexture

open fun renderBackgroundTexture(context: DrawContext)

renderContents

open fun renderContents(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

Render call that should be used to render the main contents of a subclass. This is used instead of overriding render for proper positioning of the popup stack.

renderWithTooltip

fun renderWithTooltip(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

resetHover

open override fun resetHover(mouseX: Double, mouseY: Double)

When called the parent element should reselect a hovered element based on the supplied mouse positions, if it tracks such things

resize

open override fun resize(client: MinecraftClient, width: Int, height: Int)

setFocused

open override fun setFocused(focused: Boolean)

setPopup

open fun setPopup(widget: PopupWidget?, mouseX: Double? = null, mouseY: Double? = null)

Applies a popup widget to this parent. If null is passed, removes the top (newest) popup instead

setTooltip

open fun setTooltip(tooltip: MutableList<OrderedText>)

open fun setTooltip(tooltip: MutableList<OrderedText>, positioner: TooltipPositioner, focused: Boolean)

open fun setTooltip(tooltip: Tooltip, positioner: TooltipPositioner, focused: Boolean)

shouldCloseOnEsc

open fun shouldCloseOnEsc(): Boolean

shouldPause

open fun shouldPause(): Boolean

tick

open fun tick()

updateNarrator

open fun updateNarrator()

PopupWidgetScreen

Author

Since

Parameters

See also

Constructors

Properties

Functions